home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / rbbsrdb.zip / RDB.DOC < prev    next >
Text File  |  1990-05-22  |  7KB  |  211 lines
  1. Documentation for Remote Data Base
  2. by Ken Goosens
  3. 22 May 1990
  4.  
  5. Remote Data Base (RDB) is a new, built in facility in RBBS 17.2A.
  6. It gives the sysop the ability to:
  7.  
  8. o   set up unlimited numbers of named data bases
  9.  
  10. o   set up menus to interact with the user
  11.  
  12. o   prompt users for data
  13.  
  14. o   use Metavariables - both work variables and SmartText variables.
  15.  
  16. o   store user's answers in work variables.   Any subfield in a
  17.     work variable can be referenced.
  18.  
  19. o   display, or store all metavariables
  20.  
  21. o   process commands conditionally
  22.  
  23. o   save Metavariables to file thru templates, allowing data to
  24.     be stored in virtually any format desired
  25.  
  26. o   retrieve data into templates for display.
  27.  
  28. o   do full screen data entry
  29.  
  30.  
  31.                   Full Screen Processing
  32.  
  33. RBBS now supports "full screen" questionnaires and macros, though this
  34. takes some work on the sysop's part to set up.  Essentially you use
  35. ANSI screen commands, transmit a template which clears the
  36. screen at the top, and then transmit the data into the template.
  37. The "full screen" is not the complete full screen in which the caller
  38. can use keys like tab and arrows to move around.  It is full screen
  39. in the sense that the caller sees all the data that is to be enterred
  40. and the cursor moves from field to field.
  41.  
  42.  
  43.                    Examples of Applications
  44.  
  45. For Sale - ask user item, price, who to contact, telephone #.
  46.     Callers can add items, or view list of items.
  47.  
  48. BBS lists - Callers can view data base, or add BBS's where
  49.     asked for name, numbers, profile of features.  No longer do
  50.     BBS ads have to be left in messages.   Can have informative,
  51.     standardized profile that makes BBS comparision meaningful.
  52.  
  53. BIO - ask users for a profile of themselves so others can know
  54.     who they are.
  55.  
  56. VOTING - can collect nominations say for best GIF files.  No
  57.     way yet to force a caller to vote only once.
  58.  
  59.  
  60.                 Details of an Application
  61.  
  62. This application manages a data base of who is willing to help
  63. with RBBS by topic.   It is controlled at a high level by the
  64. following questionnaire.
  65.  
  66. C:DUMMY.DAT,4
  67. * This questionnaire is for finding help with RBBS by topic.
  68. * Please register yourself if you
  69. *   o  are willing to help others, and
  70. *   o  know enough about a topic to help
  71. *
  72. * Examples of topics people need help with:
  73. *   Desqview       Modem models (HST, Everex, USR Internal, etc.)
  74. *   PC-Slaves      Protocols     Conferences    FMS
  75. *   Doors          DoubleDos     Subboards      PUI
  76. *   Questionnaires 10-Net        Marcos         Uploads
  77. *   MU-Purge       File maint.   Personal dwld  Caller Analysis
  78. *
  79. :-[prompt]-
  80. T
  81. ?1 V)iew database, E)nter new data, Q)uit (V,A,Q)
  82. >-.[1].-
  83. :-.V.-
  84. :-.E.-
  85. :-.Q.-
  86. =V-[view]-=E-[add]-=Q-[quit]-= -[prompt]-
  87. :-[view]-
  88. M C:\RBBS\VIEWHELP.IMC
  89. >-[prompt]-
  90. :-[quit]-
  91. @
  92. :-[add]-
  93. *                  703-978-6360
  94. ?1 BBS data number
  95. *                                   703-978-4339
  96. ?2 Voice # (evening, 0 not to give)
  97. * You can specify as many topics as desired, one at a time.
  98. *
  99. :-[topic]-
  100. ?3 RBBS topic you will help others with, or Q)uit
  101. =Q-[prompt]-= -[addrec]-
  102. :-[addrec]-
  103. * -Topic-         - Data # -      - Voice # -   Last Name       First Name
  104. */FL[3]              [1]             [2]            {LN             {FN          
  105. T
  106. ?Really add this record (Y,N)
  107. =Y-[really]-=N-[topic]-= -[addrec]-
  108. :-[really]-
  109. M C:\RBBS\ADDHELP.IMC
  110. >-[topic]-
  111.  
  112. Two macros are used by this questionnaire:  VIEWHELP.IMC for displaying
  113. the data base, and ADDHELP.IMC for appending new data to the data base.
  114. For more documentation on macro commands, see MACROS.DOC.
  115. VIEWHELP.IMC contains
  116.  
  117. 5
  118. {*1 -Topic-         - Data # -      - Voice # -   Last Name       First Name
  119. {*F C:\RBBS\RBBSHELP.DAT
  120.  
  121. ADDHELP.IMC contains
  122.  
  123. 5
  124. {>> C:\RBBS\RBBSHELP.DAT /FL
  125. [3]              [1]             [2]            {LN             {FN          
  126. {END    
  127.  
  128.                     A Full Screen Application
  129.  
  130. Full screen is available only in a color graphics version of questionnaires
  131. and macros.   A long application for collecting BBS information is given
  132. in these following files:
  133.  
  134. REGRBBS.DEF  - Questionnaire driver, TTY version
  135. REGRBBSC.DEF - Color graphics version of questionnaire driver
  136. VUNRBBS.IMC  - View data base macro, TTY version
  137. VUNRBBSC.IMC - View data base macro, Color graphics version
  138. SVRBBS.IMC   - Macro to save data to a comma separated data file
  139. NATLRBBS.DAT - Data Base created by SVRBBS.IMC
  140.  
  141.  
  142.              Hints a Building Your own Applications
  143.  
  144. Make sure in CONFIG that you have specified enough work variables
  145. as the largest variable you reference by number in questionnaires
  146. and macros.   This is parameter 94.   It is especially important
  147. to set if you have upgraded from a version of RBBS prior to 17.2.
  148. Remember to set this parameter in your subboards as well.
  149.  
  150. Note that the examples assume your application resides on drive
  151. C, subdirectory RBBS.    You must edit the questionnaires and
  152. macros if this is not true.
  153.  
  154. In the macro execute commands in questionnaires and macros, you
  155. can use any extension for macros you want and are not limited to
  156. the extension specified in CONFIG for interactive macros.   The
  157. examples use "IMC" (internal macro) rather than "MCR" used for
  158. macros invoked interactively at prompts by the caller.
  159.  
  160. The questionnaires will have to be listed in MENUA (names in all
  161. caps, followed by a space) in order to be operative.
  162.  
  163. Generally you will have
  164.  
  165. o    a questionnaire driver that gives caller option to exit, view
  166.      database, or Enter new data.
  167.  
  168. o    a macro to retrieve data from file to a form
  169.  
  170. o    a macro to save data in a data base format.
  171.  
  172. o    a data entry routine in the questionnaire.
  173.  
  174. Full screen is more complicated that TTY.  Generally, you will want
  175.  
  176. o    to paint a template with all everything but the data values,
  177.      such as row and column labels and titles.
  178.  
  179. o    to clear out the existing values in a form and then put in
  180.      the new values.
  181.  
  182. You transmit only the changes to a screen rather than retransmitting
  183. the entire screen when only a part changes.
  184.  
  185. You use ANSI commands to control the screen.   Where [ESC] stands
  186. for the one-character Escape (ascii 27), the most useful ANSI commands
  187. to know are:
  188.  
  189. [ESC][2J   -  clear the screen.
  190.  
  191. [ESC][K    -  clear from current cursor postion to end of line.  Cursor
  192.               position after clearing is same as before.
  193.  
  194. [ESC][X;Yf -  position the cursor on row x and column Y.  E.g.
  195.               "[ESC][5;10f" positions on column 10 of row 5.
  196.  
  197. Case is signficant in ANSI commands, so beware that "[ESC][k" will NOT
  198. clear to end of line, and "[ESC][1;7F" will not position the cursor.
  199.  
  200. You can use ANSI commands to reverse the video and change blinking and
  201. set color.   An easy way consistent with RBBS to set colors is to use
  202. the SmartText variables C0, C1, ..., C4, where 1-4 are the colors set
  203. on config and C0 is "emphasis off" that restores normal text color
  204. perference of the caller.  E.g.
  205.  
  206. [ESC][2J{C1[ESC]1;15fSample Title-{C0  [1]
  207.  
  208. clears the screen, sets color to 1, positions on line 1, column 15,
  209. prints "Sample Title-", sets color to caller's text preference, prints
  210. 2 spaces, then prints value of work variable 1.
  211.